Repository navigation
docs: qualify README API coverage and raw access claims - #1185
Merged
Merged
Conversation
joshrotenberg
commented
Oct 9, 2026
joshrotenberg
left a comment
Collaborator
Author
There was a problem hiding this comment.
Looks good. The revised claims are accurate and match what the repo ships. Only optional nits below.
I checked the changes against these sources:
- "300+ tools" (README hunk 1, wording unchanged): this still holds as a lower bound. AGENTS.md lists about 364 tools, and
crates/redisctl-mcp/Cargo.tomlenablescloud,enterpriseanddatabaseby default. - Raw API wording (hunk 3): this matches
docs/docs/reference/compatibility.md:38, which says endpoint availability and payloads are controlled by the upstream service. The exampleredisctl api cloud get ...matches theHttpMethodenum incrates/redisctl/src/cli/mod.rs:283. - Matrix link (hunk 2): it points to the same issue (#1085) that
compatibility.md:43links. - Renamed headings and removed claims: changing "Full API Coverage" to "Management" and "any Redis instance" to "Redis" removes the overclaims. The listed areas did not change.
Findings:
- nit (README, "Key Capabilities", Raw API bullet):
compatibility.md:38marks raw Cloud/Enterprise API access as Preview. Consider adding "(preview)" so the README matches the compatibility table. - nit (README, "What's Covered" intro): the README calls it a "support and validation matrix" but
compatibility.md:43calls it a "support matrix". Using one name in both places makes them easier to cross-reference. - nit (README, MCP Server paragraph, wording unchanged): "300+ tools" assumes the default features. A short "with default features" would keep the count correct for
--no-default-featuresbuilds. This was already the case before this PR, so it's optional here.
I found no broken links, stale version numbers or changed command examples.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scope
README-only contribution to #1085; leaves #1085 open.
Replaced five absolute/universal claims with descriptive Cloud/Enterprise/MCP/database capability language. Added an explicit CLI-vs-MCP/product-version qualifier, linked the unfinished support/validation matrix, and clarified that raw API requests remain subject to upstream endpoint availability, payloads and permissions.
No full matrix or new supported/tested version/architecture claims. No runtime, defaults, credentials, configuration schema, CI/settings policy or release changes. Other open PRs remain untouched.
Validation
Checkpoint
Head:
bc3c40b80b70e5bbdd61c0e40c29ef5c08bb4e27.Implementation, focused local validation and independent review finished. Exact-head hosted checks reconciled (including individual mandatory jobs/steps, not just aggregate status); ready for required human review. No merge/release. The full #1085 support matrix remains outstanding.
CI · Documentation · Release plan.